# eric7.Plugins.VcsPlugins.vcsGit.ProjectHelper

Module implementing the VCS project helper for Git.

### Global Attributes

None

### Classes

GitProjectHelper | Class implementing the VCS project helper for Git.

### Functions

None

## GitProjectHelper

Class implementing the VCS project helper for Git.

### Derived from

VcsProjectHelper

### Class Attributes

None

### Class Methods

None

### Methods

GitProjectHelper | Constructor
__gitAddRemote | Private slot to add a remote repository.
__gitApplyPatches | Private slot to apply a list of patch files.
__gitBisectBad | Private slot used to execute the bisect bad command.
__gitBisectCreateReplay | Private slot used to create a replay file for the current bisect session.
__gitBisectEditReplay | Private slot used to edit a bisect replay file.
__gitBisectGood | Private slot used to execute the bisect good command.
__gitBisectLogBrowser | Private slot used to show the bisect log browser window.
__gitBisectReplay | Private slot used to replay a bisect session.
__gitBisectReset | Private slot used to execute the bisect reset command.
__gitBisectSkip | Private slot used to execute the bisect skip command.
__gitBisectStart | Private slot used to execute the bisect start command.
__gitBisectStartExtended | Private slot used to execute the bisect start command with options.
__gitBranch | Private slot used to perform branch operations for the project.
__gitBranchList | Private slot used to list the branches of the project.
__gitBundle | Private slot used to create a bundle file.
__gitBundleFetch | Private slot to apply a head of a bundle file using the fetch method.
__gitBundleListHeads | Private slot used to list the heads contained in a bundle file.
__gitBundlePull | Private slot to apply a head of a bundle file using the pull method.
__gitCancelMerge | Private slot used to cancel an uncommitted or failed merge.
__gitChangeRemoteUrl | Private slot to change the URL of a remote repository.
__gitCheckPatches | Private slot to check a list of patch files, if they would apply cleanly.
__gitCherryPick | Private slot used to copy commits into the current branch.
__gitCherryPickAbort | Private slot used to cancel the last copying session and return to the previous state.
__gitCherryPickContinue | Private slot used to continue the last copying session after conflicts were resolved.
__gitCherryPickQuit | Private slot used to quit the current copying operation.
__gitCommitMerge | Private slot used to commit the ongoing merge.
__gitConfigure | Private method to open the configuration dialog.
__gitCreateArchive | Private slot used to create an archive from the local repository.
__gitCreateIgnore | Private slot used to create a .gitignore file for the project.
__gitDeleteBranch | Private slot used to delete a branch from a remote repository.
__gitDescribeTag | Private slot to show the most recent tag.
__gitEditRepoConfig | Private slot used to edit the repository configuration file.
__gitEditUserConfig | Private slot used to edit the user configuration file.
__gitExtendedDiff | Private slot used to perform a git diff with the selection of revisions.
__gitFetch | Private slot used to fetch changes from a remote repository.
__gitHouseKeeping | Private slot used to cleanup and optimize the local repository.
__gitMergedBranchList | Private slot used to list the merged branches of the project.
__gitNotMergedBranchList | Private slot used to list the not merged branches of the project.
__gitPruneRemote | Private slot to prune stale tracking branches of a remote repository.
__gitPull | Private slot used to pull changes from a remote repository.
__gitPush | Private slot used to push changes to a remote repository.
__gitReflogBrowser | Private slot to show the reflog of the current project.
__gitRemoteCredentials | Private slot to change or set the user credentials for a remote repository.
__gitRemoveRemote | Private slot to remove a remote repository.
__gitRenameRemote | Private slot to rename a remote repository.
__gitRevert | Private slot used to revert changes made to the local project.
__gitShowBranch | Private slot used to show the current branch for the project.
__gitShowConfig | Private slot used to show the combined configuration.
__gitShowPatchStatistics | Private slot to show some patch statistics.
__gitShowRemote | Private slot used to show information about a remote repository.
__gitShowRemotes | Private slot used to show the available remote repositories.
__gitStashApply | Private slot to restore a stash and keep it.
__gitStashBranch | Private slot to create a new branch and restore a stash into it.
__gitStashBrowser | Private slot used to show the stash browser dialog.
__gitStashClear | Private slot to clear all stashes.
__gitStashDrop | Private slot to drop a stash.
__gitStashPop | Private slot to restore a stash and delete it.
__gitStashSave | Private slot to stash all current changes.
__gitStashShow | Private slot to show the contents of the selected stash.
__gitStatistics | Private slot used to show some statistics of the local repository.
__gitSubmoduleAdd | Private slot to add a submodule to the current project.
__gitSubmodulesDeinit | Private slot to unregister submodules of the project.
__gitSubmodulesInit | Private slot to initialize submodules of the project.
__gitSubmodulesList | Private slot to list the submodules defined for the current project.
__gitSubmodulesStatus | Private slot to show the status of submodules of the project.
__gitSubmodulesSummary | Private slot to show summary information for submodules of the project.
__gitSubmodulesSync | Private slot to synchronize URLs of submodules of the project.
__gitSubmodulesUpdate | Private slot to update submodules of the project.
__gitSubmodulesUpdateInit | Private slot to initialize and update submodules of the project.
__gitSubmodulesUpdateOptions | Private slot to update submodules of the project with options.
__gitSubmodulesUpdateRemote | Private slot to fetch and update submodules of the project.
__gitTagList | Private slot used to list the tags of the project.
__gitUnstage | Private slot used to unstage changes made to the local project.
__gitVerify | Private slot used to verify the connectivity and validity of objects of the database.
__gitVerifyBundle | Private slot used to verify a bundle file.
__gitWorktreeManagement | Private slot to show the worktree management dialog.
getActions | Public method to get a list of all actions.
getProject | Public method to get a reference to the project object.
initActions | Public method to generate the action objects.
initMenu | Public method to generate the VCS menu.
initToolbar | Public slot to initialize the VCS toolbar.
removeToolbar | Public method to remove a toolbar created by initToolbar().
setObjects | Public method to set references to the vcs and project objects.
shutdown | Public method to perform shutdown actions.

### Static Methods

None

#### GitProjectHelper (Constructor)

GitProjectHelper(vcsObject, projectObject, parent=None, name=None)

Constructor

vcsObject (Git)
  reference to the vcs object
projectObject (Project)
  reference to the project object
parent (QWidget)
  parent widget
name (str)
  name of this object

#### GitProjectHelper.__gitAddRemote

__gitAddRemote()

Private slot to add a remote repository.

#### GitProjectHelper.__gitApplyPatches

__gitApplyPatches()

Private slot to apply a list of patch files.

#### GitProjectHelper.__gitBisectBad

__gitBisectBad()

Private slot used to execute the bisect bad command.

#### GitProjectHelper.__gitBisectCreateReplay

__gitBisectCreateReplay()

Private slot used to create a replay file for the current bisect session.

#### GitProjectHelper.__gitBisectEditReplay

__gitBisectEditReplay()

Private slot used to edit a bisect replay file.

#### GitProjectHelper.__gitBisectGood

__gitBisectGood()

Private slot used to execute the bisect good command.

#### GitProjectHelper.__gitBisectLogBrowser

__gitBisectLogBrowser()

Private slot used to show the bisect log browser window.

#### GitProjectHelper.__gitBisectReplay

__gitBisectReplay()

Private slot used to replay a bisect session.

#### GitProjectHelper.__gitBisectReset

__gitBisectReset()

Private slot used to execute the bisect reset command.

#### GitProjectHelper.__gitBisectSkip

__gitBisectSkip()

Private slot used to execute the bisect skip command.

#### GitProjectHelper.__gitBisectStart

__gitBisectStart()

Private slot used to execute the bisect start command.

#### GitProjectHelper.__gitBisectStartExtended

__gitBisectStartExtended()

Private slot used to execute the bisect start command with options.

#### GitProjectHelper.__gitBranch

__gitBranch()

Private slot used to perform branch operations for the project.

#### GitProjectHelper.__gitBranchList

__gitBranchList()

Private slot used to list the branches of the project.

#### GitProjectHelper.__gitBundle

__gitBundle()

Private slot used to create a bundle file.

#### GitProjectHelper.__gitBundleFetch

__gitBundleFetch()

Private slot to apply a head of a bundle file using the fetch method.

#### GitProjectHelper.__gitBundleListHeads

__gitBundleListHeads()

Private slot used to list the heads contained in a bundle file.

#### GitProjectHelper.__gitBundlePull

__gitBundlePull()

Private slot to apply a head of a bundle file using the pull method.

#### GitProjectHelper.__gitCancelMerge

__gitCancelMerge()

Private slot used to cancel an uncommitted or failed merge.

#### GitProjectHelper.__gitChangeRemoteUrl

__gitChangeRemoteUrl()

Private slot to change the URL of a remote repository.

#### GitProjectHelper.__gitCheckPatches

__gitCheckPatches()

Private slot to check a list of patch files, if they would apply cleanly.

#### GitProjectHelper.__gitCherryPick

__gitCherryPick()

Private slot used to copy commits into the current branch.

#### GitProjectHelper.__gitCherryPickAbort

__gitCherryPickAbort()

Private slot used to cancel the last copying session and return to the previous state.

#### GitProjectHelper.__gitCherryPickContinue

__gitCherryPickContinue()

Private slot used to continue the last copying session after conflicts were resolved.

#### GitProjectHelper.__gitCherryPickQuit

__gitCherryPickQuit()

Private slot used to quit the current copying operation.

#### GitProjectHelper.__gitCommitMerge

__gitCommitMerge()

Private slot used to commit the ongoing merge.

#### GitProjectHelper.__gitConfigure

__gitConfigure()

Private method to open the configuration dialog.

#### GitProjectHelper.__gitCreateArchive

__gitCreateArchive()

Private slot used to create an archive from the local repository.

#### GitProjectHelper.__gitCreateIgnore

__gitCreateIgnore()

Private slot used to create a .gitignore file for the project.

#### GitProjectHelper.__gitDeleteBranch

__gitDeleteBranch()

Private slot used to delete a branch from a remote repository.

#### GitProjectHelper.__gitDescribeTag

__gitDescribeTag()

Private slot to show the most recent tag.

#### GitProjectHelper.__gitEditRepoConfig

__gitEditRepoConfig()

Private slot used to edit the repository configuration file.

#### GitProjectHelper.__gitEditUserConfig

__gitEditUserConfig()

Private slot used to edit the user configuration file.

#### GitProjectHelper.__gitExtendedDiff

__gitExtendedDiff()

Private slot used to perform a git diff with the selection of revisions.

#### GitProjectHelper.__gitFetch

__gitFetch()

Private slot used to fetch changes from a remote repository.

#### GitProjectHelper.__gitHouseKeeping

__gitHouseKeeping()

Private slot used to cleanup and optimize the local repository.

#### GitProjectHelper.__gitMergedBranchList

__gitMergedBranchList()

Private slot used to list the merged branches of the project.

#### GitProjectHelper.__gitNotMergedBranchList

__gitNotMergedBranchList()

Private slot used to list the not merged branches of the project.

#### GitProjectHelper.__gitPruneRemote

__gitPruneRemote()

Private slot to prune stale tracking branches of a remote repository.

#### GitProjectHelper.__gitPull

__gitPull()

Private slot used to pull changes from a remote repository.

#### GitProjectHelper.__gitPush

__gitPush()

Private slot used to push changes to a remote repository.

#### GitProjectHelper.__gitReflogBrowser

__gitReflogBrowser()

Private slot to show the reflog of the current project.

#### GitProjectHelper.__gitRemoteCredentials

__gitRemoteCredentials()

Private slot to change or set the user credentials for a remote repository.

#### GitProjectHelper.__gitRemoveRemote

__gitRemoveRemote()

Private slot to remove a remote repository.

#### GitProjectHelper.__gitRenameRemote

__gitRenameRemote()

Private slot to rename a remote repository.

#### GitProjectHelper.__gitRevert

__gitRevert()

Private slot used to revert changes made to the local project.

#### GitProjectHelper.__gitShowBranch

__gitShowBranch()

Private slot used to show the current branch for the project.

#### GitProjectHelper.__gitShowConfig

__gitShowConfig()

Private slot used to show the combined configuration.

#### GitProjectHelper.__gitShowPatchStatistics

__gitShowPatchStatistics()

Private slot to show some patch statistics.

#### GitProjectHelper.__gitShowRemote

__gitShowRemote()

Private slot used to show information about a remote repository.

#### GitProjectHelper.__gitShowRemotes

__gitShowRemotes()

Private slot used to show the available remote repositories.

#### GitProjectHelper.__gitStashApply

__gitStashApply()

Private slot to restore a stash and keep it.

#### GitProjectHelper.__gitStashBranch

__gitStashBranch()

Private slot to create a new branch and restore a stash into it.

#### GitProjectHelper.__gitStashBrowser

__gitStashBrowser()

Private slot used to show the stash browser dialog.

#### GitProjectHelper.__gitStashClear

__gitStashClear()

Private slot to clear all stashes.

#### GitProjectHelper.__gitStashDrop

__gitStashDrop()

Private slot to drop a stash.

#### GitProjectHelper.__gitStashPop

__gitStashPop()

Private slot to restore a stash and delete it.

#### GitProjectHelper.__gitStashSave

__gitStashSave()

Private slot to stash all current changes.

#### GitProjectHelper.__gitStashShow

__gitStashShow()

Private slot to show the contents of the selected stash.

#### GitProjectHelper.__gitStatistics

__gitStatistics()

Private slot used to show some statistics of the local repository.

#### GitProjectHelper.__gitSubmoduleAdd

__gitSubmoduleAdd()

Private slot to add a submodule to the current project.

#### GitProjectHelper.__gitSubmodulesDeinit

__gitSubmodulesDeinit()

Private slot to unregister submodules of the project.

#### GitProjectHelper.__gitSubmodulesInit

__gitSubmodulesInit()

Private slot to initialize submodules of the project.

#### GitProjectHelper.__gitSubmodulesList

__gitSubmodulesList()

Private slot to list the submodules defined for the current project.

#### GitProjectHelper.__gitSubmodulesStatus

__gitSubmodulesStatus()

Private slot to show the status of submodules of the project.

#### GitProjectHelper.__gitSubmodulesSummary

__gitSubmodulesSummary()

Private slot to show summary information for submodules of the project.

#### GitProjectHelper.__gitSubmodulesSync

__gitSubmodulesSync()

Private slot to synchronize URLs of submodules of the project.

#### GitProjectHelper.__gitSubmodulesUpdate

__gitSubmodulesUpdate()

Private slot to update submodules of the project.

#### GitProjectHelper.__gitSubmodulesUpdateInit

__gitSubmodulesUpdateInit()

Private slot to initialize and update submodules of the project.

#### GitProjectHelper.__gitSubmodulesUpdateOptions

__gitSubmodulesUpdateOptions()

Private slot to update submodules of the project with options.

#### GitProjectHelper.__gitSubmodulesUpdateRemote

__gitSubmodulesUpdateRemote()

Private slot to fetch and update submodules of the project.

#### GitProjectHelper.__gitTagList

__gitTagList()

Private slot used to list the tags of the project.

#### GitProjectHelper.__gitUnstage

__gitUnstage()

Private slot used to unstage changes made to the local project.

#### GitProjectHelper.__gitVerify

__gitVerify()

Private slot used to verify the connectivity and validity of objects of the database.

#### GitProjectHelper.__gitVerifyBundle

__gitVerifyBundle()

Private slot used to verify a bundle file.

#### GitProjectHelper.__gitWorktreeManagement

__gitWorktreeManagement()

Private slot to show the worktree management dialog.

#### GitProjectHelper.getActions

getActions()

Public method to get a list of all actions.

Return:
  list of all actions

Return Type:
  list of EricAction

#### GitProjectHelper.getProject

getProject()

Public method to get a reference to the project object.

Return:
  reference to the project object

Return Type:
  Project

#### GitProjectHelper.initActions

initActions()

Public method to generate the action objects.

#### GitProjectHelper.initMenu

initMenu(menu)

Public method to generate the VCS menu.

menu (QMenu)
  reference to the menu to be populated

#### GitProjectHelper.initToolbar

initToolbar(ui, toolbarManager)

Public slot to initialize the VCS toolbar.

ui (UserInterface)
  reference to the main window
toolbarManager (EricToolBarManager)
  reference to a toolbar manager object

#### GitProjectHelper.removeToolbar

removeToolbar(ui, toolbarManager)

Public method to remove a toolbar created by initToolbar().

ui (UserInterface)
  reference to the main window
toolbarManager (EricToolBarManager)
  reference to a toolbar manager object

#### GitProjectHelper.setObjects

setObjects(vcsObject, projectObject)

Public method to set references to the vcs and project objects.

vcsObject (Git)
  reference to the vcs object
projectObject (Project)
  reference to the project object

#### GitProjectHelper.shutdown

shutdown()

Public method to perform shutdown actions.

Up